oracle.AWXML
Class SolveGroup

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.SolveGroup

public class SolveGroup

extends BaseObject

A collection of Solve objects. A Solve is a calculation that can be performed on data in an analytic workspace. A Solve can specify how to aggregate or allocate the data or generate a forecast based on the data.

Solves are ordered within a SolveGroup. The order determines when the calculations will be performed during an analytic workspace build. The AWAction.BuildDatabase class builds an analytic workspace.

A SolveGroup is a top-level object in the hierarchy of model objects. Top-level objects are logically owned by an AW object, and they exist within the name space of the schema.

The SolveGroup class supports methods for building the logical object in memory and action methods for physically creating it or deleting it within the Oracle Database. The action methods take an AWConnection argument that specifies a JDBC connection to the Database.

See Also:

BuildDatabase

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

SolveGroup()
Creates a SolveGroup.

Method Summary

void	addSolve(Solve input) Adds the specified Solve to the SolveGroup.
void	addSolveAfter(Solve input, BaseObject reference) Adds the specified Solve after the referenced Solve in the SolveGroup.
void	addSolveBefore(Solve input, BaseObject reference) Adds the specified Solve before the referenced Solve in the SolveGroup.
void	addSolveFirst(Solve input) Adds the specified Solve to the beginning of the list of solves in the SolveGroup.
java.lang.String	Alter(AWConnection connection) Alters the class attributes of the object in the current analytic workspace of the specified database connection.
java.lang.String	Create(AWConnection connection) Creates the SolveGroup in the current analytic workspace of the specified database connection.
AggregationSolve	createAggregationSolve() Creates an AggregationSolve in the SolveGroup.
AggregationSolve	createAggregationSolveAfter(Solve input) Creates an AggregationSolve after the referenced Solve in the SolveGroup.
AggregationSolve	createAggregationSolveBefore(Solve input) Creates an AggregationSolve before the referenced Solve in the SolveGroup.
AggregationSolve	createAggregationSolveFirst() Creates an AggregationSolve and adds it to the beginning of the list of solves in the SolveGroup.
AllocationSolve	createAllocationSolve() Creates an AllocationSolve in the SolveGroup.
AllocationSolve	createAllocationSolveAfter(Solve input) Creates an AllocationSolve after the referenced Solve in the SolveGroup.
AllocationSolve	createAllocationSolveBefore(Solve input) Creates an AllocationSolve before the referenced Solve in the SolveGroup.
AllocationSolve	createAllocationSolveFirst() Creates an AllocaationSolve and adds it to the beginning of the list of solves in the SolveGroup.
ForecastSolve	createForecastSolve() Creates a ForecastSolve in the SolveGroup.
ForecastSolve	createForecastSolveAfter(Solve input) Creates a ForecastSolve after the referenced Solve in the SolveGroup.
ForecastSolve	createForecastSolveBefore(Solve input) Creates a ForecastSolve before the referenced Solve in the SolveGroup.
ForecastSolve	createForecastSolveFirst() Creates a ForecastSolve and adds it to the beginning of the list of solves in the SolveGroup.
java.lang.String	Delete(AWConnection connection) Deletes the SolveGroup in the current analytic workspace of the specified database connection.
java.lang.String	getId() Gets the identifier of the SolveGroup.
java.util.Vector	getSolves() Returns the solves in the SolveGroup.
void	readAWDefinitions(AWConnection connection, AW curAW) Reads into memory all the objects owned by the SolveGroup within the specified analytic workspace of the specified database connection.
void	removeSolve(Solve input) Removes the specified Solve from the SolveGroup.
java.lang.String	WriteToXML() Returns the SolveGroup as an XML string.

Methods inherited from class oracle.AWXML.BaseObject

CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SolveGroup

public SolveGroup()

Creates a SolveGroup.

Method Detail

getId

public java.lang.String getId()

Gets the identifier of the SolveGroup. The identifier is the full name of the SolveGroup in the format name.type.

For more information on object identifiers, see Object Identifiers.

Overrides:

getId in class BaseObject

Returns:

A String that contains the identifier of the SolveGroup.

WriteToXML

public java.lang.String WriteToXML()

Returns the SolveGroup as an XML string.

Overrides:

WriteToXML in class BaseObject

Returns:

A String containing the XML that represents the SolveGroup.

Create

public java.lang.String Create(AWConnection connection)

Creates the SolveGroup in the current analytic workspace of the specified database connection.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the SolveGroup in the current analytic workspace of the specified database connection.

Overrides:

Delete in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

"success" if successful.

readAWDefinitions

public void readAWDefinitions(AWConnection connection,
                              AW curAW)

Reads into memory all the objects owned by the SolveGroup within the specified analytic workspace of the specified database connection.

Parameters:

connection - The AWConnection that specifies the database connection.

curAW - The AW that contains the SolveGroup.

createAggregationSolve

public AggregationSolve createAggregationSolve()

Creates an AggregationSolve in the SolveGroup.

Returns:

The new AggregationSolve.

createAggregationSolveAfter

public AggregationSolve createAggregationSolveAfter(Solve input)

Creates an AggregationSolve after the referenced Solve in the SolveGroup.

Parameters:

input - The referenced Solve.

Returns:

The new AggregationSolve.

createAggregationSolveBefore

public AggregationSolve createAggregationSolveBefore(Solve input)

Creates an AggregationSolve before the referenced Solve in the SolveGroup.

Parameters:

input - The referenced Solve.

Returns:

The new AggregationSolve.

createAggregationSolveFirst

public AggregationSolve createAggregationSolveFirst()

Creates an AggregationSolve and adds it to the beginning of the list of solves in the SolveGroup.

Returns:

The new AggregationSolve.

createAllocationSolve

public AllocationSolve createAllocationSolve()

Creates an AllocationSolve in the SolveGroup.

Returns:

The new AllocationSolve.

createAllocationSolveAfter

public AllocationSolve createAllocationSolveAfter(Solve input)

Creates an AllocationSolve after the referenced Solve in the SolveGroup.

Parameters:

input - The referenced Solve.

Returns:

The new AllocationSolve.

createAllocationSolveBefore

public AllocationSolve createAllocationSolveBefore(Solve input)

Creates an AllocationSolve before the referenced Solve in the SolveGroup.

Parameters:

input - The referenced Solve.

Returns:

The new AllocationSolve.

createAllocationSolveFirst

public AllocationSolve createAllocationSolveFirst()

Creates an AllocaationSolve and adds it to the beginning of the list of solves in the SolveGroup.

Returns:

The new AllocationSolve.

createForecastSolve

public ForecastSolve createForecastSolve()

Creates a ForecastSolve in the SolveGroup.

Returns:

The new ForecastSolve.

createForecastSolveAfter

public ForecastSolve createForecastSolveAfter(Solve input)

Creates a ForecastSolve after the referenced Solve in the SolveGroup.

Parameters:

input - The referenced Solve.

Returns:

The new ForecastSolve.

createForecastSolveBefore

public ForecastSolve createForecastSolveBefore(Solve input)

Creates a ForecastSolve before the referenced Solve in the SolveGroup.

Parameters:

input - The referenced Solve.

Returns:

The new ForecastSolve.

createForecastSolveFirst

public ForecastSolve createForecastSolveFirst()

Creates a ForecastSolve and adds it to the beginning of the list of solves in the SolveGroup.

Returns:

The new ForecastSolve.

addSolve

public void addSolve(Solve input)

Adds the specified Solve to the SolveGroup. If other solves exist in the group, adds the new one to the end of the list.

Parameters:

input - The Solve to add.

addSolveBefore

public void addSolveBefore(Solve input,
                           BaseObject reference)

Adds the specified Solve before the referenced Solve in the SolveGroup.

Parameters:

input - The Solve to add.

reference - The referenced Solve.

addSolveAfter

public void addSolveAfter(Solve input,
                          BaseObject reference)

Adds the specified Solve after the referenced Solve in the SolveGroup.

Parameters:

input - The Solve to add.

reference - The referenced Solve.

addSolveFirst

public void addSolveFirst(Solve input)

Adds the specified Solve to the beginning of the list of solves in the SolveGroup.

Parameters:

input - The Solve to add.

removeSolve

public void removeSolve(Solve input)

Removes the specified Solve from the SolveGroup.

Parameters:

input - The Solve to remove.

getSolves

public java.util.Vector getSolves()

Returns the solves in the SolveGroup.

Returns:

A Vector of Solve objects.

Alter

public java.lang.String Alter(AWConnection connection)

Description copied from class: BaseObject

Alters the class attributes of the object in the current analytic workspace of the specified database connection. You can use the Alter method to change descriptive names of the object or to reset the schema of a top-level object. To alter the structural definition of a BaseObject, you must create, modify, or remove its owned objects.

Overrides:

Alter in class BaseObject

Tags copied from class: BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

A String that contains success if this method successfully creates the BaseObject.